/*******************************************************************************
 * Copyright IBM Corp. and others 1991
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

/**
 * @file
 * @ingroup GC_Structs
 */

#if !defined(SUBLISTITERATOR_HPP_)
#define SUBLISTITERATOR_HPP_

#include "omrcfg.h"
#include "omrcomp.h"
#include "modronbase.h"

#include "SublistPool.hpp"

/**
 * Iterate over the all puddles of a sublist
 * @see MM_SublistPool
 * @ingroup GC_Structs
 */
class GC_SublistIterator
{
	MM_SublistPuddle *_currentPuddle;
	MM_SublistPool *_sublistPool;

public:
	GC_SublistIterator(MM_SublistPool *sublistPool) :
		_currentPuddle(NULL),
		_sublistPool(sublistPool)
	{}

	MM_SublistPuddle *nextList();
};

#endif /* !defined(SUBLISTITERATOR_HPP_) */
